home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2002 #11 / Amiga Plus CD - 2002 - No. 11.iso / Tools / Freeware / BasiliskII-1.0 / README < prev    next >
Text File  |  2002-09-06  |  37KB  |  858 lines
  1.  
  2.   Basilisk II
  3.   A 68k Macintosh emulator
  4.  
  5.   Copyright (C) 1997-2002 Christian Bauer et al.
  6.  
  7.  
  8. License
  9. -------
  10.  
  11. Basilisk II is available under the terms of the GNU General Public License.
  12. See the file "COPYING" that is included in the distribution for details.
  13.  
  14.  
  15. Overview
  16. --------
  17.  
  18. Basilisk II is an Open Source 68k Macintosh emulator. That is, it enables
  19. you to run 68k MacOS software on you computer, even if you are using a
  20. different operating system. However, you still need a copy of MacOS and
  21. a Macintosh ROM image to use Basilisk II.
  22.  
  23. Basilisk II has currently been ported to the following systems:
  24.   - BeOS R4 (PowerPC and x86)
  25.   - Unix (tested under Linux, Solaris 2.x, FreeBSD 3.x, NetBSD 1.4.x and
  26.     IRIX 6.5)
  27.   - AmigaOS 3.x
  28.   - Windows NT 4.0 (mostly works under Windows 95/98, too)
  29.  
  30. Some features of Basilisk II:
  31.   - Emulates either a Mac Classic (which runs MacOS 0.x thru 7.5)
  32.     or a Mac II series machine (which runs MacOS 7.x, 8.0 and 8.1),
  33.     depending on the ROM being used
  34.   - Color video display
  35.   - CD quality sound output
  36.   - Floppy disk driver (only 1.44MB disks supported)
  37.   - Driver for HFS partitions and hardfiles
  38.   - CD-ROM driver with basic audio functions
  39.   - Easy file exchange with the host OS via a "Host Directory Tree" icon
  40.     on the Mac desktop
  41.   - Ethernet driver
  42.   - Serial drivers
  43.   - SCSI Manager (old-style) emulation
  44.   - Emulates extended ADB keyboard and 3-button mouse
  45.   - Uses UAE 68k emulation or (under AmigaOS and NetBSD/m68k) real 68k
  46.     processor
  47.  
  48. The emulator is not yet complete. See the file "TODO" for a list of
  49. unimplemented stuff.
  50.  
  51.  
  52. Requirements and Installation
  53. -----------------------------
  54.  
  55. Please consult the file "INSTALL" for a list of system requirements and
  56. installation instructions.
  57.  
  58.  
  59. Configuration
  60. -------------
  61.  
  62. Basilisk II is configured via the preferences editor that appears on startup.
  63. If you have a version without preferences editor (e.g. because of missing GTK+
  64. under Unix), you have to edit the preferences file manually.
  65.  
  66. The settings are stored in a text file:
  67.  
  68. BeOS:
  69.   /boot/home/config/settings/BasiliskII_prefs
  70.  
  71. Unix:
  72.   ~/.basilisk_ii_prefs
  73.  
  74. AmigaOS:
  75.   ENV:BasiliskII_prefs
  76.  
  77. Windows:
  78.   BasiliskII_prefs (in the same directory as the executable)
  79.  
  80. If no preferences file is present, Basilisk II will create one with the
  81. default settings upon startup.
  82.  
  83.  
  84. Preferences File Format
  85. -----------------------
  86.  
  87. The preferences file is a text file editable with any text editor.
  88. Each line in this file has the format "keyword value" and describes
  89. one preferences item. For each keyword, the meaning of the "value"
  90. string may vary across platforms. The following keywords exist:
  91.  
  92. disk <volume description>
  93.  
  94.   This item describes one MacOS volume to be mounted by Basilisk II.
  95.   There can be multiple "disk" lines in the preferences file. Basilisk II
  96.   can handle hardfiles (byte-per-byte images of HFS volumes in a file on
  97.   the host system), HFS partitions on hard disks etc., and MacOS-partitioned
  98.   disks (it can only access the first partition, though). The "volume
  99.   description" is either the pathname of a hardfile or a platform-dependant
  100.   description of an HFS partition or drive. If the volume description is
  101.   prefixed by an asterisk ("*"), the volume is write protected for MacOS.
  102.  
  103.   Basilisk II can also handle some types of Mac "disk image" files directly,
  104.   as long as they are uncompressed and unencoded.
  105.  
  106.   BeOS:
  107.     To specify an HFS partition, simply specify its path (e.g.
  108.     "/dev/disk/scsi/0/1/0/0_3"). If you don't specify any volumes, Basilisk II
  109.     will search for and use all available HFS partitions.
  110.  
  111.   Unix:
  112.     To specify an HFS partition, simply specify its path (e.g. "/dev/sda5").
  113.     If you want to access a MacOS-partitioned hard disk or removable volume
  114.     (Jaz, Zip etc.) and your operating system doesn't understand MacOS
  115.     partition tables, you can specify the block device name (e.g. "/dev/sda")
  116.     to access the first HFS partition on the device. Under Linux, if you
  117.     don't specify any volumes, Basilisk II will search /etc/fstab for
  118.     unmounted HFS partitions and use these.
  119.  
  120.   AmigaOS:
  121.     Partitions/drives are specified in the following format:
  122.       /dev/<device name>/<unit>/<open flags>/<start block>/<size>/<block size>
  123.     "start block" and "size" are given in blocks, "block size" is given in
  124.     bytes.
  125.  
  126.   Windows:
  127.     To define a logical volume (Windows NT only), specify its path (e.g. "c:\").
  128.     To define a physical volume (NT and 9x), additionally give the "physical"
  129.     keyword (E.g. "physical c:\"). For safety reasons, volumes are mounted as
  130.     read-only. This is due to the bugs in PC Exchange. If you don't specify
  131.     any volume, the files *.hfv and *.dsk are searched from the current
  132.     directory. Note that in this case, Basilisk II tries to boot from the first
  133.     volume file found, which is random and may not be what you want.
  134.  
  135. floppy <floppy drive description>
  136.  
  137.   This item describes one floppy drive to be used by Basilisk II. There
  138.   can be multiple "floppy" lines in the preferences file. If no "floppy"
  139.   line is given, Basilisk II will try to automatically detect and use
  140.   installed floppy drives. The format of the "floppy drive description"
  141.   is the same as that of "disk" lines.
  142.  
  143. cdrom <CD-ROM drive description>
  144.  
  145.   This item describes one CD-ROM drive to be used by Basilisk II. There
  146.   can be multiple "cdrom" lines in the preferences file. If no "cdrom"
  147.   line is given, Basilisk II will try to automatically detect and use
  148.   installed CD-ROM drives. The format of the "CD-ROM drive description"
  149.   is the same as that of "disk" lines.
  150.  
  151. extfs <direcory path>
  152.  
  153.   This item specifies the root directory for the "Host Directory Tree"
  154.   file system (the "Unix/BeOS/Amiga/..." icon on the Finder desktop).
  155.   All objects contained in that directory are accessible by Mac applications.
  156.  
  157.   This feature is only available when File System Manager V1.2 or later
  158.   is installed on the Mac side. FSM 1.2 is built-in beginning with MacOS 7.6
  159.   and can be installed as a system extension (downloadable from Apple, look
  160.   for the FSM SDK in the developer section) for earlier MacOS versions.
  161.  
  162. scsi0 <SCSI target> ... scsi6 <SCSI target>
  163.  
  164.   These items describe the SCSI target to be used for a given Mac SCSI
  165.   ID by Basilisk II. Basilisk II emulates the old SCSI Manager and allows
  166.   to assign a different SCSI target (they don't even have to be on the
  167.   same SCSI bus) for each SCSI ID (0..6) as seen by the MacOS. "scsi0"
  168.   describes the target for ID 0, "scsi1" the target for ID 1 etc.
  169.   The format of the "SCSI target" is platform specific.
  170.  
  171.   BeOS:
  172.     The "SCSI target" has the format "<bus>/<unit>" (e.g. "0/2").
  173.     Due to a bug in BeOS, using SCSI with Basilisk II may cause the
  174.     SCSI bus to hang. Use with caution.
  175.  
  176.   Linux:
  177.     The "SCSI target" has to be the name of a device that complies to
  178.     the Generic SCSI driver API. On a standard Linux installation, these
  179.     devices are "/dev/sg0", "/dev/sg1" etc. Note that you must have
  180.     appropriate access rights to these devices and that Generic SCSI
  181.     support has to be compiled into the kernel.
  182.  
  183.   FreeBSD:
  184.     The "SCSI target" has the format "<id>/<lun>" (e.g. "2/0").
  185.  
  186.   AmigaOS:
  187.     The "SCSI target" has the format "<device name>/<unit>" (e.g.
  188.     "scsi.device/2").
  189.  
  190.   Windows:
  191.     The "SCSI target" has the format <"Vendor"> <"Model"> (e.g.
  192.     scsi0 "HP" "CD-Writer+ 7100"). Note the use of quotes.
  193.  
  194. screen <video mode>
  195.  
  196.   This item describes the type of video display to be used by default for
  197.   Basilisk II. If you are using a Mac Classic ROM, the display is always
  198.   1-bit 512x342 and this item is ignored. The format of the "video mode" is
  199.   platform specific.
  200.  
  201.   BeOS:
  202.     The "video mode" is one of the following:
  203.       win/<width>/<height>
  204.         8-bit color display in a window of the given size. This is the
  205.         default.
  206.       scr/<mode>
  207.         Full-screen display in BWindowScreen. <mode> is the bit number of
  208.         the video mode to use (see headers/be/interface/GraphicsDefs.h).
  209.         E.g. 0 = 640x480x8, 1 = 800x600x8 etc., 10 = 640x480x24,
  210.         11 = 800x600x24 etc., 18 = 640x480x15, 19 = 800x600x15 etc.
  211.         15 bit modes are preferable to 16 bit modes (which may show false
  212.         colors on PowerPC machines).
  213.     When you run in full-screen mode and switch to another Workspace,
  214.     Basilisk II is put in "suspend" mode (i.e. MacOS will be frozen).
  215.  
  216.   Unix:
  217.     The "video mode" is one of the following:
  218.       win/<width>/<height>
  219.         Color display in an X11 window of the given size. There are several
  220.         resolutions and color depths available. The set of color depths
  221.         depends on the capabilities of the X11 server, the operating system,
  222.         and Basilisk II compile-time options, but 1 bit and the default depth
  223.         of the X11 screen should always be available.
  224.       dga/<width>/<height>
  225.         [if Basilisk II was configured with --enable-xf86-dga]
  226.         Full-screen display using the XFree86 DGA extension. The color depth
  227.         (8/15/24 bit) depends on the depth of the underlying X11 screen.
  228.         "width" and "height" specify the maximum width/height to use.
  229.         Saying "dga/0/0" means "complete screen".
  230.       dga/<frame buffer name>
  231.         [if Basilisk II was configured with --enable-fbdev-dga]
  232.         Full-screen display using the frame buffer device /dev/fb. The color
  233.         depth (8/15/24 bit) depends on the depth of the underlying X11 screen.
  234.         The "frame buffer name" is looked up in the "fbdevices" file (whose
  235.         path can be specified with the "fbdevicefile" prefs item) to determine
  236.         certain characteristics of the device (doing a "ls -l /dev/fb" should
  237.         tell you what your frame buffer name is).
  238.  
  239.   AmigaOS:
  240.     The "video mode" is one of the following:
  241.       win/<width>/<height>
  242.         Black-and-white display in a window of the given size on the
  243.         Workbench screen. This is the default and will also be used when
  244.         one of the other options (PIP/screen) fails to open.
  245.       pip/<width>/<height>
  246.         15-bit truecolor display in a Picasso96 PIP. This requires
  247.         Picasso96 as well as a PIP-capable graphics card (e.g. Picasso IV).
  248.       scr/<hexadecimal mode ID>
  249.         8/15/24-bit fullscreen display on a Picasso96/CyberGraphX screen with
  250.         the given mode ID. This requires Picasso96 or CyberGraphX. For 15 and
  251.         24 bit, the frame buffer format must be QuickDraw-compatible
  252.         (big-endian, xRGB 1:5:5:5 or xRGB 8:8:8:8). The screen size will be
  253.         the default size for that mode ID.
  254.  
  255.   Windows:
  256.     The "video mode" is one of the following:
  257.       win/<width>/<height>/<bits per pixel>
  258.         A refreshed screen mode that uses Windows GDI calls to write to the
  259.         screen. You may have other windows on top of Basilisk II.
  260.       dx/<width>/<height>/<bits per pixel>
  261.         A refreshed DirectX mode (minimum version 5.0). There are ways to
  262.         install DirectX 5 on NT 4. Some new display adapters work fine even
  263.         with DirectX 3.
  264.       fb/<width>/<height>/<bits per pixel>
  265.         A non-refreshed video mode that works only on NT. It accesses the
  266.         linear frame buffer directly (best performance of all three modes).
  267.         Use the hotkey Control-Shift-F12 to switch between Windows and Mac
  268.         displays. Fast task switch (Alt-Tab) and Explorer start menu
  269.         (Control-Esc) are disabled, Control-Alt-Del is enabled.
  270.     <width> and <height> can be either zeroes (uses current screen values),
  271.     or something else. "win" mode can use almost anything, for other modes
  272.     there must be a corresponding DirectX mode.
  273.     <bits> is ignored for mode "win" (uses current screen values).
  274.     If the mode is "win" and the dimensions are different than the desktop
  275.     dimensions, windowed mode is used. The window can be moved around by
  276.     dragging with the right mouse button. This mode remembers window positions
  277.     separately for different dimensions.
  278.     The supported values are 8,15,16,24,32. It is possible that some of them
  279.     do not work for you. In particular, it may be that only one of the
  280.     two modes, 15 and 16, is suitable for your card. You need to find out
  281.     the best solution by experimenting.
  282.     Basilisk II checks what display mode you are currently running and uses
  283.     that mode. The screen is always full screen. When you switch to another
  284.     application via Alt-Tab, Basilisk II is put in "snooze" mode (i.e. MacOS
  285.     is frozen).
  286.  
  287. seriala <serial port description>
  288.  
  289.   This item describes the serial port to be used as Port A (Modem Port)
  290.   by Basilisk II. If no "seriala" line is given, Basilisk II will try to
  291.   automatically detect and use installed serial ports. The "serial port
  292.   description" is a platform-dependant description of a serial port.
  293.  
  294.   BeOS:
  295.     Either specify the name of a serial port (e.g. "serial1") or one of
  296.     "parallel1", "parallel2" or "parallel3". See below for more information
  297.     about parallel ports.
  298.  
  299.   Unix:
  300.     Specify the device name of a serial port (e.g. "/dev/ttyS0") or a
  301.     parallel "lp" port (e.g. "/dev/lp1"; this only works under Linux and
  302.     FreeBSD). See below for more information about parallel ports.
  303.  
  304.   AmigaOS:
  305.     You have to specify the name of the serial device and the device unit
  306.     as "<device name>/<unit>" (e.g. "serial.device/0"). If the given device
  307.     is not compatible to serial.device, Basilisk II will crash. If the
  308.     device name starts with an asterisk (e.g. "*parallel.device/0"), the
  309.     device is treated as a parallel.device compatible device. See below for
  310.     more information about parallel ports.
  311.  
  312.   Windows:
  313.     Specify "COM1" or "COM2" for com port 1 or 2, respectively.
  314.  
  315.   Parallel ports: If you select a parallel port it will look like a serial
  316.   port to MacOS but Basilisk II will only allow data output and ignore baud
  317.   rate settings etc. You should be able to get some printers to work with
  318.   this method (provided that you have the right printer driver, like
  319.   "Power Print" (see www.gdt.com)).
  320.  
  321. serialb <serial port description>
  322.  
  323.   This item describes the serial port to be used as Port B (Printer Port)
  324.   by Basilisk II. If no "serialb" line is given, Basilisk II will try to
  325.   automatically detect and use installed serial ports. The format of the
  326.   "serial port description" is the same as that of the "seriala" option.
  327.  
  328. ether <ethernet card description>
  329.  
  330.   This item describes the Ethernet card to be used for Ethernet networking
  331.   by Basilisk II. If no "ether" line is given, Ethernet networking is disabled
  332.   (although the Ethernet driver of Basilisk II will behave like a "dummy"
  333.   Ethernet card in this case). If you are using a Mac Classic ROM, Ethernet
  334.   is not available and this setting is ignored. The "ethernet card description"
  335.   is a platform-dependant description of an ethernet card.
  336.  
  337.   General note: To use TCP/IP from MacOS, you should assign a different IP
  338.   address to the MacOS (entered into the MacOS TCP/IP (or MacTCP) control
  339.   panel). Otherwise there will be confusion about which operating system will
  340.   handle incoming packets.
  341.  
  342.   BeOS:
  343.     It doesn't matter what you give as "ethernet card description", Basilisk II
  344.     will always use the first Ethernet card it finds as long an an "ether"
  345.     line exists (e.g. say "ether yes"). Using Ethernet requires the "sheep_net"
  346.     Net Server add-on to be installed. The first time you start Basilisk II
  347.     with Ethernet enabled you will be asked whether it's OK to make the
  348.     necessary changes to your BeOS network configuration to enable sheep_net.
  349.  
  350.   Linux:
  351.     The "ethernet card description" is the name of an Ethernet interface.
  352.     There are two approaches to networking with Basilisk II:
  353.  
  354.       1. Direct access to an Ethernet card via the "sheep_net" kernel module.
  355.          The "ethernet card description" must be the name of a real Ethernet
  356.          card, e.g. "eth0".
  357.  
  358.          The sheep_net module is included in the Basilisk II source
  359.          distribution in the directory "src/Unix/Linux/NetDriver". You have
  360.          to compile and install the module yourself:
  361.  
  362.            $ su
  363.            [enter root password]
  364.            # make
  365.            # make dev
  366.            [this will create a /dev/sheep_net device node; you should give
  367.             appropriate access rights to the user(s) running Basilisk II]
  368.            # insmod sheep_net.o
  369.  
  370.          If you copy the sheep_net.o module to a place where it can be found
  371.          by the kernel module loader ("/lib/modules/<version>/kernel/drivers/net"
  372.          for 2.4 kernels) and add the line
  373.  
  374.            alias char-major-10-198 sheep_net
  375.  
  376.          to "/etc/modules.conf", the kernel should be able to load the module
  377.          automatically when Basilisk II is started.
  378.  
  379.          The sheep_net module will allow you to run all networking protocols
  380.          under MacOS (TCP/IP, AppleTalk, IPX etc.) but there is no connection
  381.          between Linux networking and MacOS networking. MacOS will only be
  382.          able to talk to other machines on the Ethernet, but not to other
  383.          networks that your Linux box routes (e.g. a second Ethernet or a PPP
  384.          connection to the Internet).
  385.  
  386.       2. Putting Basilisk II on a virtual Ethernet via the "ethertap" device.
  387.          In this case, the "ethernet card description" must be the name
  388.          of an ethertap interface, e.g. "tap0". It also requires that you
  389.          configure your kernel to enable routing and ethertap support:
  390.          under "Networking options", enable "Kernel/User netlink socket" and
  391.          "Netlink device emulation", under "Network device support", activate
  392.          "Ethertap network tap". You also have to modify drivers/net/ethertap.c
  393.          a bit before compiling the new kernel:
  394.  
  395.           - insert "#define CONFIG_ETHERTAP_MC 1" near the top (after the
  396.             #include lines)
  397.           - comment out the line "dev->flags|=IFF_NOARP;" in ethertap_probe()
  398.  
  399.          Next, see /usr/src/linux/Documentation/networking/ethertap.txt for
  400.          information on how to set up /dev/tap* device nodes and activate the
  401.          ethertap interface. Under MacOS, select an IP address that is on the
  402.          virtual network and set the default gateway to the IP address of the
  403.          ethertap interface. This approach will let you access all networks
  404.          that your Linux box has access to (especially, if your Linux box has
  405.          a dial-up Internet connection and is configured for IP masquerading,
  406.          you can access the Internet from MacOS). The drawback is that you
  407.          can only use network protocols that Linux can route, so you have to
  408.          install and configure netatalk if you want to use AppleTalk. Here is
  409.          an example /etc/atalk/atalkd.conf for a LAN:
  410.  
  411.            eth0 -seed -phase 2 -net 1 -addr 1.47 -zone "Ethernet"
  412.            tap0 -seed -phase 2 -net 2 -addr 2.47 -zone "Basilisknet"
  413.  
  414.          (the "47" is an arbitrary node number). This will set up a zone
  415.          "Ethernet" (net 1) for the Ethernet and a zone "Basilisknet" (net 2)
  416.          for the internal network connection of the ethertap interface.
  417.          MacOS should automatically recognize the nets and zones upon startup.
  418.          If you are in an existing AppleTalk network, you should contact
  419.          your network administrator about the nets and zones you can use
  420.          (instead of the ones given in the example above).
  421.  
  422.   FreeBSD:
  423.     The "ethertap" method described above also works under FreeBSD, but since
  424.     no-one has found the time to write a section for this manual, you're on
  425.     your own here...
  426.  
  427.   AmigaOS:
  428.     You have to specify the name of the SANA-II Ethernet device and the device
  429.     unit as "<device name>/<unit>" (e.g. "ariadne.device/0"). If the given
  430.     device is not a SANA-II device, Basilisk II will crash. If the device is
  431.     not an Ethernet device, Basilisk II will display a warning message and
  432.     disable Ethernet networking.
  433.  
  434.   See the next item for an alternative way to do networking with Basilisk II.
  435.  
  436. udptunnel <"true" or "false">
  437.  
  438.   Setting this to "true" enables a special network mode in which all network
  439.   packets sent by MacOS are tunnelled over UDP using the host operating
  440.   system's native TCP/IP stack. This can only be used to connect computers
  441.   running Basilisk II (and not, for example, for connecting to the Internet
  442.   or an AppleShare server running on a real Mac), but it is probably the
  443.   easiest way to set up a network between two instances of Basilisk II
  444.   because the UDP tunnelling doesn't require any special kernel modules or
  445.   network add-ons. It relies on IP broadcasting, however, so its range is
  446.   limited. It should be fine though for doing a little file sharing or
  447.   playing Spectre.
  448.  
  449. udpport <IP port number>
  450.  
  451.   This item specifies the IP port number to use for the "UDP Tunnel" mode.
  452.   The default is 6066.
  453.  
  454. rom <ROM file path>
  455.  
  456.   This item specifies the file name of the Mac ROM file to be used by
  457.   Basilisk II. If no "rom" line is given, the ROM file has to be named
  458.   "ROM" and put in the same directory as the Basilisk II executable.
  459.  
  460. bootdrive <drive number>
  461.  
  462.   Specify MacOS drive number of boot volume. "0" (the default) means
  463.   "boot from first bootable volume".
  464.  
  465. bootdriver <driver number>
  466.  
  467.   Specify MacOS driver number of boot volume. "0" (the default) means
  468.   "boot from first bootable volume". Use "-62" to boot from CD-ROM.
  469.  
  470. ramsize <bytes>
  471.  
  472.   Allocate "bytes" bytes of RAM for MacOS system and application memory.
  473.   The value given will be rounded down to the nearest multiple of 1MB.
  474.   If you are using a Mac Classic ROM, the maximum available value is 4MB
  475.   and higher values will be ignored. The default is 8MB.
  476.  
  477. frameskip <frames to skip>
  478.  
  479.   For refreshed graphics modes (usually window modes), this specifies
  480.   how many frames to skip after drawing one frame. Higher values make
  481.   the video display more responsive but require more processing power.
  482.   The default is "8". Under Unix/X11, a value of "0" selects a "dynamic"
  483.   update mode that cuts the display into rectangles and updates each
  484.   rectangle individually, depending on display changes.
  485.  
  486. modelid <MacOS model ID>
  487.  
  488.   Specifies the Macintosh model ID that Basilisk II should report to MacOS.
  489.   The default is "5" which corresponds to a Mac IIci. If you want to run
  490.   MacOS 8, you have to set this to "14" (Quadra 900). Other values are not
  491.   officially supported and may result in crashes. MacOS versions earlier
  492.   than 7.5 may only run with the Model ID set to "5". If you are using a Mac
  493.   Classic ROM, the model is always "Mac Classic" and this setting is
  494.   ignored.
  495.  
  496. nosound <"true" or "false">
  497.  
  498.   Set this to "true" to disable all sound output. This is useful if the
  499.   sound takes too much CPU time on your machine or to get rid of warning
  500.   messages if Basilisk II can't use your audio hardware.
  501.  
  502. nocdrom <"true" or "false">
  503.  
  504.   Set this to "true" to disable Basilisk's built-in CD-ROM driver.
  505.   The only reason to do this is if you want to use a third-party CD-ROM
  506.   driver that uses the SCSI Manager. The default is "false".
  507.  
  508. nogui <"true" or "false">
  509.  
  510.   Set this to "true" to disable the GUI preferences editor and GUI
  511.   error alerts. All errors will then be reported to stdout. The default
  512.   is "false".
  513.  
  514. For additional information, consult the source.
  515.  
  516.  
  517. System-specific configuration
  518. -----------------------------
  519.  
  520. Unix:
  521.  
  522.   keycodes <"true" or "false">
  523.   keycodefile <keycodes file path>
  524.  
  525.     By default, the X11 event handler in Basilisk II uses KeySyms to
  526.     translate keyboard event to Mac keycodes. While this method is very
  527.     compatible and ought to work with all X servers, it only works well
  528.     if your keyboard has a US layout. If you set "keycodes" to "true",
  529.     Basilisk II will use raw keycodes instead of KeySyms. The keycode
  530.     depends only on the physical location of a key on the keyboard and
  531.     not on the selected keymap. Unfortunately it depends on the X server
  532.     being used and possibly also on the type of keyboard attached. So
  533.     Basilisk II needs a table to translate X keycodes to Mac keycodes.
  534.     This table is read by default from /usr/local/share/BasiliskII/keycodes
  535.     unless you specify a different file with the "keycodefile" item.
  536.     A sample keycode file is included with Basilisk II.
  537.  
  538.   fbdevicefile <fbdevices file path>
  539.  
  540.     This option specifies the file that contains frame buffer device
  541.     specifications for the fbdev-DGA video mode (when Basilisk II was
  542.     configured with --enable-fbdev-dga). The default location of the file
  543.     is /usr/local/share/BasiliskII/fbdevices. A sample file is included
  544.     with Basilisk II.
  545.  
  546.   mousewheelmode <mode>
  547.  
  548.     If you have a mouse with a wheel, this option specifies whether moving
  549.     the wheel will be reported to the MacOS as "Page up/down" (mode 0) or
  550.     "Cursor up/down" (mode 1) keys.
  551.  
  552.   mousewheellines <number of lines>
  553.  
  554.     If "mousewheelmode" is set to mode 1 (Cursor up/down), this option sets
  555.     the number of key events sent to MacOS for each wheel movement (the
  556.     number of lines to scroll).
  557.  
  558. AmigaOS:
  559.  
  560.   sound <sound output description>
  561.  
  562.     This item specifies what method to use for sound output. The only choice
  563.     is currently AHI, but you can specify the AHI mode ID to be used. The
  564.     "sound output description" looks like this:
  565.  
  566.       ahi/<hexadecimal mode ID>
  567.  
  568.   scsimemtype <type>
  569.  
  570.     This item controls the type of memory to use for SCSI buffers. Possible
  571.     values are:
  572.       0 Chip memory
  573.       1 24-bit DMA capable memory
  574.       2 Any memory
  575.  
  576.     Be warned that many SCSI host adapters will not work with the "Any memory"
  577.     setting. Basilisk II has no way of knowing which memory type is supported
  578.     by the host adapter and setting an unsupported type will result in data
  579.     corruption.
  580.  
  581. Windows:
  582.  
  583.   noscsi <"true" or "false">
  584.  
  585.     Completely disables SCSI Manager support when set to "true".
  586.     Note that currently all SCSI operations are executed synchronously,
  587.     even if Mac application has requested asynchronous operation. What this
  588.     means is that the control is not returned to the application until the
  589.     command is completely finished. Normally this is not an issue, but when a
  590.     CDR/CDRW is closed or erased the burner program typically wants to wait in
  591.     some progress dialog the result may be that the application reports a
  592.     time-out error, but the operation completes all right anyway.
  593.  
  594.   nofloppyboot <"true" or "false">
  595.  
  596.     Set this to "true" to disable booting from a floppy.
  597.  
  598.   replacescsi <"Vendor1"> <"Model1"> <"Vendor2"> <"Model2">
  599.  
  600.     This command tricks the Mac to believe that you have a SCSI device Model2
  601.     from vendor Vendor2, although your real hardware is Model1 from Vendor1.
  602.     This is very useful since many devices have almost identical ATAPI and SCSI
  603.     versions of their hardware, and MacOS applications usually support the SCSI
  604.     version only. The example below is typical:
  605.  
  606.       replacescsi "HP" "CD-Writer+ 7100" "PHILIPS" "CDD3600"
  607.  
  608.     Note the use of quotes.
  609.  
  610.   rightmouse <0/1>
  611.  
  612.     Defines what the right mouse button is used for. The default values of 0
  613.     means that it is used to move windowed mode BasiliskII screen.
  614.     Value 1 sends a combination Control and mouse click to the MacOS.
  615.     This may be useful under OS versions 8 and above.
  616.  
  617.   keyboardfile <path>
  618.  
  619.     Defines the path of the customized keyboard code file.
  620.  
  621.   pollmedia <"true" or "false">
  622.  
  623.     If true (default), tries to automatically detect new media.
  624.     Applies to all "floppy", "cd" or "disk" removable media except
  625.     1.44 MB floppies. May cause modest slow down. If unchecked, 
  626.     use Ctrl-Shift-F11 to manually mount new media.
  627.     If you have auto-insert notification (AIN) enabled, you may turn this
  628.     option off. Note that some CD related software require AIN,
  629.     and some other need it to be turned off. Consult the documentation
  630.     of your CD software to learn which one is optimal for you.
  631.  
  632.   framesleepticks <milliseconds>
  633.  
  634.     The amount of time between video frames.
  635.  
  636.   showfps <true/false>
  637.  
  638.     If true, the real frame rate is displayed.
  639.  
  640.   stickymenu <true/false>
  641.  
  642.     If true, the main menu bar is kept open even after the mouse button is
  643.     released, under all OS versions (OS 8 has this feature already). There
  644.     are extensions to do the same thing, but it's faster to handle this in
  645.     native code. Default is "true".
  646.  
  647.   ntdx5hack <"true" or "false">
  648.  
  649.     You may need this on NT if your display adapter driver has a bug in
  650.     DirectX palette support. Black and white are reversed. It fixes the
  651.     palette issue by using GDI palette instead of D3D palette. Default is
  652.     false.
  653.  
  654.  
  655. Usage
  656. -----
  657.  
  658. Quitting:
  659.   The right way to quit Basilisk II is to select the "Shut Down" menu item
  660.   from the Finder's "Special" menu. You should not kill it from the shell
  661.   unless it hangs. Under Unix, pressing "Esc" while holding the Ctrl key will
  662.   also quit Basilisk II (in case you are using it in DGA mode and it crashed).
  663.   Under Windows, try Alt-F4 (or Control-Alt-Del to log off and back on again
  664.   if it crashes really badly).
  665.  
  666. Suspending:
  667.   The Unix version of Basilisk II can be suspended while running in DGA mode
  668.   by pressing "Tab" while holding the Ctrl key. Pressing "Space" in the
  669.   "suspended" window will resume the emulation. Under BeOS, switching to
  670.   a different Workspace when BasiliskII is in full-screen mode will also
  671.   suspend the emulation.
  672.  
  673. Keyboard:
  674.   On PC-style keyboards, "Alt" is the Mac "Command" key, while the "Windows"
  675.   key is the Mac "Option" key.
  676.  
  677. Mouse:
  678.   Under Unix, pressing Ctrl-F5 while the Basilisk II window is active will
  679.   grab the mouse. This is needed for compatibility with some MacOS programs,
  680.   especially games such as flight simulators. Press Ctrl-F5 again to return
  681.   to normal mouse operation.
  682.  
  683. Floppy:
  684.   Basilisk II can only handle 1.44MB MFM floppies. Depending on your platform,
  685.   floppy disk changes might not be detected automatically. Under Unix, press
  686.   Ctrl-F1 to mount a floppy. Under BeOS, select the appropriate "Mount" menu
  687.   item or press Ctrl-F1 to mount a floppy. Under Windows, press Ctrl-Shift-F11.
  688.  
  689. HFS partitions:
  690.   Having HFS partitions mounted for read-write access under Basilisk II while
  691.   they are also mounted on the host OS will most likely result in volume
  692.   corruption and data loss. Unmount your HFS volumes before starting
  693.   Basilisk II.
  694.  
  695. ZIP drives:
  696.   Iomega ZIP disks can be mounted either with the "disk" prefs item or (on
  697.   platforms that support the SCSI Manager emulation of Basilisk II) by
  698.   installing the IomegaWare on the Mac side. Do not use both ways
  699.   simultaneously!
  700.  
  701. Hardfiles:
  702.   In addition to plain images of HFS volumes, Basilisk II can also handle
  703.   some types of Mac "disk image" files, as long as they are uncompressed
  704.   and unencoded.
  705.  
  706. Mac Classic emulation:
  707.   Sound output and Ethernet are not supported if you are using a Mac Classic
  708.   ROM. Also, the video display is fixed to 512x342 in monochrome. The AmigaOS
  709.   and BeOS/PPC versions of Basilisk II cannot do Mac Classic emulation.
  710.  
  711. Video resolution switching:
  712.   Run-time switching of video resolutions requires the Display Manager. This
  713.   is included in MacOS versions 7.6 and above, and available as a system
  714.   extension for earlier MacOS versions as a free download from ftp.apple.com
  715.   (look for "Display Software 2.x"). Click on "Options..." in the "Monitors"
  716.   control panel to select the resolution.
  717.  
  718. Sound output:
  719.   Sound output under Basilisk II requires Sound Manager 3.0 or later. This
  720.   is included in MacOS versions 7.5 and above, and available as a system
  721.   extension for earlier MacOS versions as a free download from ftp.apple.com.
  722.   Sample rate, bit resolution and mono/stereo can be selected in the Sound
  723.   control panel (section "Sound Out").
  724.  
  725. Ethernet:
  726.   Basilisk II supports all Ethernet protocols. Running a protocol under
  727.   Basilisk II that already runs within the host operating system on the same
  728.   network card (e.g. running MacTCP under Basilisk II on a BeOS machine) may
  729.   or may not work (generally, it should work, but some specific things like
  730.   "ping" may not). If you have problems with FTP, try setting the FTP client
  731.   to passive mode.
  732.  
  733. LocalTalk:
  734.   LocalTalk is not supported by Basilisk II. There is no way of getting
  735.   LocalTalk to work with the serial drivers of Basilisk II. Any attempt to
  736.   activate LocalTalk will either result in a crash or revert to Ethernet.
  737.  
  738. Serial:
  739.   You can use the serial ports in Basilisk II to connect to the Internet
  740.   with a modem and the "MacPPP" or "Open Transport/PPP" software.
  741.  
  742.  
  743. Technical Documentation
  744. -----------------------
  745.  
  746. Please see the included file "TECH" for a technical overview of the emulator.
  747.  
  748.  
  749. Acknowledgements
  750. ----------------
  751.  
  752. Contributions by (in alphabetical order):
  753.  - Orlando Bassotto <future@powercube.mediabit.net>: FreeBSD support
  754.  - Gwenolé Beauchesne <gb@dial.oleane.com>: SPARC assembly optimizations,
  755.    lots of work on the Unix video code
  756.  - Marc Chabanas <Marc.Chabanas@france.sun.com>: Solaris sound support
  757.  - Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code
  758.    and networking
  759.  - Bill Huey <billh@mag.ucsd.edu>: 15/16 bit DGA and 15/16/32 bit X11
  760.    window support
  761.  - Brian J. Johnson <bjohnson@sgi.com>: IRIX support
  762.  - Jürgen Lachmann <juergen_lachmann@t-online.de>: AmigaOS CyberGraphX support
  763.  - Samuel Lander <blair_sp@hotmail.com>: tile-based window refresh code
  764.  - David Lawrence <davidl@jlab.org>: incremental window refresh code
  765.  - Lauri Pesonen <lpesonen@nic.fi>: Windows NT port
  766.  - Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation
  767.  - and others...
  768.  
  769. Special thanks to:
  770.  - Bernd Schmidt for letting me use his UAE 68k emulation
  771.  - Daniel Bobbert who printed dozens of pages from the THINK Reference for
  772.    me years ago
  773.  - All ShapeShifter and SheepShaver users and beta testers
  774.  - Apple Computer Inc., who made writing a Macintosh emulator a child's play
  775.  
  776.  
  777. Bug reports
  778. -----------
  779.  
  780. You found a bug? Well, use the source, fix it and send the fix to
  781.   <Christian.Bauer@uni-mainz.de>
  782. for inclusion in the next release of Basilisk II.
  783.  
  784. If you don't have a fix, you should post a bug report using the Source Forge
  785. bug tracker, supplying as much information as possible (operating system and
  786. versions of Basilisk II and MacOS being used, relevant hardware information,
  787. the exact steps to reproduce the bug, etc.):
  788.   http://sourceforge.net/tracker/?group_id=2123&atid=102123
  789.  
  790. I also strongly suggest reading this before posting a bug report:
  791.   http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
  792.  
  793.  
  794. Author
  795. ------
  796.  
  797. You can contact me at <Christian.Bauer@uni-mainz.de>, but please don't do
  798. so unless absolutely necessary. I'm maintaining Basilisk II in my spare
  799. time and am not able to provide technical support for everyone. If you have
  800. questions, consider posting them to one of the support forums mentioned
  801. below.
  802.  
  803. You are encouraged to contact me personally when
  804.  - you have bug fixes or small enhancements for the code
  805.  - you want to port Basilisk II to another platform
  806.  - you want to discuss technical issues
  807.  - you intend to make major changes to the source; you might be working on
  808.    something that I have already done, or I may have different ideas about
  809.    the Right Way to do it
  810.  
  811. There is no point in sending me questions about
  812.  - ROM files and how/where to get them
  813.  - versions of Basilisk II that run on operating systems other than Unix,
  814.    BeOS and AmigaOS. If you are using any other operating system, there's
  815.    no point in asking me how to to X or why Y doesn't work because I won't
  816.    know either. Instead, you should look in the "Acknowledgements" section
  817.    of this manual to find the person responsible. For example, if your
  818.    question is specific to the Windows operating system, ask Lauri Pesonen.
  819.    I don't have Windows and can't answer your questions and I'm too lazy to
  820.    forward mail to Lauri myself. In any case, it would probably be better
  821.    to post your questions to a public forum as it will get a much wider
  822.    audience there.
  823.  
  824.  
  825. Support
  826. -------
  827.  
  828. The official Basilisk II home page is at
  829.   http://www.uni-mainz.de/~bauec002/B2Main.html
  830.  
  831. The Basilisk II project page on SourceForge is at
  832.   http://sourceforge.net/projects/basilisk/
  833.  
  834. If you have problems, you may want to visit the Basilisk II forums:
  835.   http://sourceforge.net/forum/?group_id=2123
  836.  
  837. There is also a mailing list for Basilisk II users:
  838.   http://lists.sourceforge.net/lists/listinfo/basilisk-user
  839.  
  840. And another mailing list for Basilisk II developers:
  841.   http://lists.sourceforge.net/lists/listinfo/basilisk-devel
  842.  
  843. Some general advice about asking technical support questions can be found at
  844.   http://www.tuxedo.org/~esr/faqs/smart-questions.html
  845.  
  846. Keeping this in mind will greatly increase your chances of getting a useful
  847. answer.
  848.  
  849.  
  850. History
  851. -------
  852.  
  853. Please consult the file "ChangeLog" for the release history.
  854.  
  855.  
  856. Christian Bauer
  857. <Christian.Bauer@uni-mainz.de>
  858.